No type information for Angular(typescript) codebase

[SandeepKallepalli]

Hi,
I have worked on an angular codebase and created a codeQL database . I was able to get type informations(getType) for that codebase but now when I started querying another angular codebase I am not getting any type information for the whole codebase. Both the angular codebase are similar(developed using the same angular practices). Is there any explanation for why this codebase is not providing type information?

My Code snippet:

import { HttpClient } from '@angular/common/http';

import { Observable } from 'rxjs';

import * as uuid from 'uuid';

@Injectable({
  providedIn: 'root'
})
export class ApiService {

  constructor(
    private readonly http: HttpClient
  ) { }

  private _getCorrelationId = () => uuid.v4();

  public get(url, options?): Observable<any> {
    return this.http.get(url, {
      withCredentials: true,
      headers: {
        'Client-Correlation-Id': this._getCorrelationId(),
        'Content-type': 'application/json;v=1',
        'Accept': 'application/json;v=1'
       },
      ...options
    });
  }

I want all the apiService.get calls being made for which i need the type information. The code snippet is present in both the angular codebases but getting the type information for one codebase but not the second one.

[esbena]

Hi. This sounds surprising, lets try to figure this out together.

Background

getType/0 depends on the information we get from the TypeScript compiler itself. So if the project can be compiled with TypeScript, then there ought to be type information in lots of places in the database.

codeql/javascript/ql/src/semmle/javascript/Expr.qll

Lines 170 to 176 in b794fcb

	/**
	* Gets the static type of this expression, as determined by the TypeScript type system.
	*
	* Has no result if the expression is in a JavaScript file or in a TypeScript
	* file that was extracted without type information.
	*/
	Type getType() { ast_node_type(this, result) }

---

Tasks

As a sanity check: does the following query produce a non-zero number?

select count(any(Expr e))

What about this query?

select count(any(Expr e | exists(e.getType())))

Can you then describe how TypeScript compiles the problematic project? What does your tsconfig.json setup look like?

[SandeepKallepalli]

Hi . Thanks for the reply.
Outputs :
select count(any(Expr e)) --> non-zero
select count(any(Expr e | exists(e.getType()))) --> 0

The problematic project is compiled normally with command ng build
tsconfig.json:

{
  "compileOnSave": false,
  "compilerOptions": {
    "allowJs": true,
    "baseUrl": "./",
    "downlevelIteration": true,
    "importHelpers": true,
    "module": "es2020",
    "outDir": "./dist/out-tsc",
    "sourceMap": true,
    "declaration": false,
    "moduleResolution": "node",
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "paths": {
      "@features/*": ["./src/app/features/*"],
      "@shared/*": ["./src/app/shared/*"],
      "@core/*": ["./src/app/core/*"]
    },
    "target": "es2015",
    "typeRoots": [
      "node_modules/@types"
    ],
    "lib": [
      "es2017",
      "dom"
    ]
  },
  "include": [
    "node_modules/@refi/web-sdk"
  ]
}

[esbena]

Just checking: is the problematic project closed source, or are you able to share it in full here?

[SandeepKallepalli]

Its closed source.So can't share the whole code.

[asgerf]

Hi @SandeepKallepalli

I think this part of the tsconfig file is the troublemaker:

  "include": [
    "node_modules/@refi/web-sdk"
  ]

There seems to be an issue when the only entry point is in the node_modules folder. It's an unusual setup as NPM packages normally contain the .js and .d.ts files, but not the original .ts files. Are you actually recompiling the web-sdk package as part of the angular app?

In any case, I'll see if I can add support for this pattern, but in the meantime you may be able to work around this by running npm install in the repository before running the extractor.

[github-actions]

This issue is stale because it has been open 14 days with no activity. Comment or remove the stale label in order to avoid having this issue closed in 7 days.