Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incompabilities after upgrade and regenerate the code from 2.4.0 to 2.5.3 #624

Closed
yangricardo opened this issue Mar 9, 2023 · 8 comments
Labels
area:core Issues related to `core`, which is the package that powers the SDKs at runtime bug Something isn't working question Further information is requested

Comments

@yangricardo
Copy link

Hi,
I am facing some issues after upgrade some modules.

image

Argument of type 'import("/home/yang/projects/pfc-monorepo/packages/zoop/node_modules/oas/dist/index").default' is not assignable to parameter of type 'import("/home/yang/projects/pfc-monorepo/node_modules/oas/dist/index").default'.
Property 'promises' is protected but type 'Oas' is not a class derived from 'Oas'.ts

It seems that the new generated code has some with the Oas dependency

Also, when i generate new code, the Oas.Init call is not recognized as function, when i run with tsx

@erunion erunion added bug Something isn't working question Further information is requested area:core Issues related to `core`, which is the package that powers the SDKs at runtime labels Mar 9, 2023
@erunion
Copy link
Member

erunion commented Mar 9, 2023

That's weird. Which library are you referring to with version 2.4.0 and 2.5.3? We haven't released either of those versions for this library.

It looks like you generated this SDK with the latest release, v5.0.7, and oas is not a new dependency there.

Which version of Node and NPM are you running? Are you running Yarn?

@yangricardo
Copy link
Author

Yes, i am running Yarn. the versions mentioned were about the oas, but when i try to run new installs, there are still some error.
I tried to downgrade to the version 2.4.0 but the issue that appears
image

About my environment:
image

I tried with npm, but also having troubles

@yangricardo
Copy link
Author

Does it is compatible with turborepo?
What i am trying to do is to turn the code generated by this library a turborepo package.
The test i was trying to run were with the tsx tool and the build inside my monorepo for the package with tsup.

I am trying to do this because there are related but diferent frontend and backend apps that will refer to this packages

@yangricardo
Copy link
Author

I tried to clean my workspace, node_modules and lockfiles to have all artifacts in a fresh install, but the the first issue seems to happen again.

Here some highlights about the last working code from yarn.lock that i could identify.

Seems that new installations are some way incompatible with [email protected], by my lock file, the last compatible is [email protected]

[email protected]:
  version "5.0.7"
  resolved "https://registry.npmjs.org/api/-/api-5.0.7.tgz"
  integrity sha512-KTDQ1GPY55E4vGSCx17ZjwYw3jAoiyiloXrxRiDT3e4EQFQN7zHa14co75GBa+YDte6GrH7M2jNNdpC6Mul+QQ==
  dependencies:
    "@readme/oas-to-har" "^20.0.2"
    "@readme/openapi-parser" "^2.4.0"
    caseless "^0.12.0"
    chalk "^4.1.2"
    commander "^10.0.0"
    datauri "^4.1.0"
    execa "^5.1.1"
    fetch-har "^8.1.5"
    figures "^3.2.0"
    find-cache-dir "^3.3.1"
    form-data-encoder "^1.7.2"
    formdata-node "^4.3.2"
    get-stream "^6.0.1"
    isomorphic-fetch "^3.0.0"
    js-yaml "^4.1.0"
    json-schema-to-ts "^2.6.2-beta.0"
    json-schema-traverse "^1.0.0"
    lodash.camelcase "^4.3.0"
    lodash.deburr "^4.1.0"
    lodash.merge "^4.6.2"
    lodash.setwith "^4.3.2"
    lodash.startcase "^4.4.0"
    make-dir "^3.1.0"
    node-abort-controller "^3.0.1"
    oas "^20.4.0"
    ora "^5.4.1"
    prettier "^2.8.3"
    prompts "^2.4.2"
    remove-undefined-objects "^2.0.2"
    semver "^7.3.8"
    ssri "^10.0.1"
    ts-morph "^17.0.1"
    validate-npm-package-name "^5.0.0"
    
    oas-kit-common@^1.0.8:
  version "1.0.8"
  resolved "https://registry.npmjs.org/oas-kit-common/-/oas-kit-common-1.0.8.tgz"
  integrity sha512-pJTS2+T0oGIwgjGpw7sIRU8RQMcUoKCDWFLdBqKB2BNmGpbBMH2sdqAaOXUg8OzonZHU0L7vfJu1mJFEiYDWOQ==
  dependencies:
    fast-safe-stringify "^2.0.7"

oas-linter@^3.2.2:
  version "3.2.2"
  resolved "https://registry.npmjs.org/oas-linter/-/oas-linter-3.2.2.tgz"
  integrity sha512-KEGjPDVoU5K6swgo9hJVA/qYGlwfbFx+Kg2QB/kd7rzV5N8N5Mg6PlsoCMohVnQmo+pzJap/F610qTodKzecGQ==
  dependencies:
    "@exodus/schemasafe" "^1.0.0-rc.2"
    should "^13.2.1"
    yaml "^1.10.0"

oas-normalize@^8.3.0:
  version "8.3.2"
  resolved "https://registry.npmjs.org/oas-normalize/-/oas-normalize-8.3.2.tgz"
  integrity sha512-xjPRdN9l27BxaR4+LYnJo/0SMw9nMBtCQ/NPejXT5dxw+is0j05PTgVnGxm6G+QTk2Y35hND4F9lNuPKk9Zw2A==
  dependencies:
    "@readme/openapi-parser" "^2.4.0"
    js-yaml "^4.1.0"
    node-fetch "^2.6.1"
    openapi-types "^12.1.0"
    postman-to-openapi "^3.0.1"
    swagger2openapi "^7.0.8"

oas-resolver@^2.5.6:
  version "2.5.6"
  resolved "https://registry.npmjs.org/oas-resolver/-/oas-resolver-2.5.6.tgz"
  integrity sha512-Yx5PWQNZomfEhPPOphFbZKi9W93CocQj18NlD2Pa4GWZzdZpSJvYwoiuurRI7m3SpcChrnO08hkuQDL3FGsVFQ==
  dependencies:
    node-fetch-h2 "^2.3.0"
    oas-kit-common "^1.0.8"
    reftools "^1.1.9"
    yaml "^1.10.0"
    yargs "^17.0.1"

oas-schema-walker@^1.1.5:
  version "1.1.5"
  resolved "https://registry.npmjs.org/oas-schema-walker/-/oas-schema-walker-1.1.5.tgz"
  integrity sha512-2yucenq1a9YPmeNExoUa9Qwrt9RFkjqaMAA1X+U7sbb0AqBeTIdMHky9SQQ6iN94bO5NW0W4TRYXerG+BdAvAQ==

oas-validator@^5.0.8:
  version "5.0.8"
  resolved "https://registry.npmjs.org/oas-validator/-/oas-validator-5.0.8.tgz"
  integrity sha512-cu20/HE5N5HKqVygs3dt94eYJfBi0TsZvPVXDhbXQHiEityDN+RROTleefoKRKKJ9dFAF2JBkDHgvWj0sjKGmw==
  dependencies:
    call-me-maybe "^1.0.1"
    oas-kit-common "^1.0.8"
    oas-linter "^3.2.2"
    oas-resolver "^2.5.6"
    oas-schema-walker "^1.1.5"
    reftools "^1.1.9"
    should "^13.2.1"
    yaml "^1.10.0"

[email protected], oas@^20.3.0, oas@^20.4.0:
  version "20.4.0"
  resolved "https://registry.npmjs.org/oas/-/oas-20.4.0.tgz"
  integrity sha512-vExbxQHWHdRz/7PrXK3L110/+ff8SK6Tq7N1PqBZiX5/WunoYLyjjDP0lq52RsWFfeluU+EzIAFodKacI5BMHQ==
  dependencies:
    "@readme/json-schema-ref-parser" "^1.2.0"
    "@types/json-schema" "^7.0.11"
    json-schema-merge-allof "^0.8.1"
    jsonpath-plus "^7.2.0"
    jsonpointer "^5.0.0"
    memoizee "^0.4.14"
    oas-normalize "^8.3.0"
    openapi-types "^12.1.0"
    path-to-regexp "^6.2.0"
    
    
"@readme/oas-extensions@^17.0.1":
  version "17.0.1"
  resolved "https://registry.npmjs.org/@readme/oas-extensions/-/oas-extensions-17.0.1.tgz"
  integrity sha512-PCU7WLz8TkbdxsiE4eQGvJYDYZQPiyLhXme3SvLboSmH+8G6AJPJ5OymzSAdlf5sXpSSoD2q3dTIou3Cb2DirQ==

"@readme/oas-to-har@^20.0.2":
  version "20.0.2"
  resolved "https://registry.npmjs.org/@readme/oas-to-har/-/oas-to-har-20.0.2.tgz"
  integrity sha512-yJ9IhEvb/UkleBYw+Br8/JlpHIKQC7EqW0BoFsXXxxbM6CQ19B2gcs2fFbNbV+hz4qXfaXZnXDw0b7KXjns3Sw==
  dependencies:
    "@readme/data-urls" "^1.0.1"
    "@readme/oas-extensions" "^17.0.1"
    oas "^20.3.0"
    qs "^6.10.5"
    remove-undefined-objects "^2.0.2"

"@readme/openapi-parser@^2.4.0":
  version "2.4.0"
  resolved "https://registry.npmjs.org/@readme/openapi-parser/-/openapi-parser-2.4.0.tgz"
  integrity sha512-KZMzLYsruShysgLgGaLNQFkinTdQu+rmVjrshhYlviHvvU6k28KYu0aOJciIQSBY0u38QHYFi74gsxU0IsmO1Q==
  dependencies:
    "@apidevtools/openapi-schemas" "^2.1.0"
    "@apidevtools/swagger-methods" "^3.0.2"
    "@jsdevtools/ono" "^7.1.3"
    "@readme/better-ajv-errors" "^1.5.0"
    "@readme/json-schema-ref-parser" "^1.2.0"
    ajv "^8.11.0"
    ajv-draft-04 "^1.0.0"
    call-me-maybe "^1.0.1"
    
 [email protected], json-schema-to-ts@^2.6.2-beta.0:
  version "2.7.2"
  resolved "https://registry.npmjs.org/json-schema-to-ts/-/json-schema-to-ts-2.7.2.tgz"
  integrity sha512-R1JfqKqbBR4qE8UyBR56Ms30LL62/nlhoz+1UkfI/VE7p54Awu919FZ6ZUPG8zIa3XB65usPJgr1ONVncUGSaQ==
  dependencies:
    "@babel/runtime" "^7.18.3"
    "@types/json-schema" "^7.0.9"
    ts-algebra "^1.2.0"

@yangricardo
Copy link
Author

yangricardo commented Mar 10, 2023

Follow my base tsconfig.json

{
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig to read more about this file */

    /* Projects */
    "incremental": true /* Save .tsbuildinfo files to allow for incremental compilation of projects. */,
    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
    "tsBuildInfoFile": "./.tsbuildinfo" /* Specify the path to .tsbuildinfo incremental compilation file. */,
    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */

    /* Language and Environment */
    "target": "ES2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
    "lib": [
      "dom",
      "dom.iterable",
      "esnext"
    ] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
    "jsx": "preserve" /* Specify what JSX code is generated. */,
    "experimentalDecorators": true /* Enable experimental support for TC39 stage 2 draft decorators. */,
    "emitDecoratorMetadata": true /* Emit design-type metadata for decorated declarations in source files. */,
    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */

    /* Modules */
    "module": "ESNext" /* Specify what module code is generated. */,
    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
    "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
    // "baseUrl": "./" /* Specify the base directory to resolve non-relative module names. */,
    // "paths": {} /* Specify a set of entries that re-map imports to additional lookup locations. */,
    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
    "types": [
      "tslib",
      "@types/node"
    ] /* Specify type package names to be included without being referenced in a source file. */,
    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
    "resolveJsonModule": true /* Enable importing .json files. */,
    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

    /* JavaScript Support */
    "allowJs": true /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */,
    "checkJs": false /* Enable error reporting in type-checked JavaScript files. */,
    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

    /* Emit */
    "declaration": false /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
    "declarationMap": false /* Create sourcemaps for d.ts files. */,
    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
    "removeComments": true /* Disable emitting comments. */,
    // "noEmit": true /* Disable emitting files from a compilation. */,
    "importHelpers": true /* Allow importing helper functions from tslib once per project, instead of including them per-file. */,
    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
    "downlevelIteration": false /* Emit more compliant, but verbose and less performant JavaScript for iteration. */,
    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

    /* Interop Constraints */
    "isolatedModules": true /* Ensure that each file can be safely transpiled without relying on other imports. */,
    "allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */,
    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
    "preserveSymlinks": true /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */,
    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,

    /* Type Checking */
    "strict": true /* Enable all strict type-checking options. */,
    "noImplicitAny": false /* Enable error reporting for expressions and declarations with an implied 'any' type. */,
    "strictNullChecks": true /* When type checking, take into account 'null' and 'undefined'. */,
    "strictFunctionTypes": true /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */,
    "strictBindCallApply": true /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */,
    "strictPropertyInitialization": true /* Check for class properties that are declared but not set in the constructor. */,
    "noImplicitThis": true /* Enable error reporting when 'this' is given the type 'any'. */,
    "useUnknownInCatchVariables": false /* Default catch clause variables as 'unknown' instead of 'any'. */,
    "alwaysStrict": true /* Ensure 'use strict' is always emitted. */,
    "noUnusedLocals": false /* Enable error reporting when local variables aren't read. */,
    "noUnusedParameters": false /* Raise an error when a function parameter isn't read. */,
    "exactOptionalPropertyTypes": false /* Interpret optional property types as written, rather than adding 'undefined'. */,
    "noImplicitReturns": false /* Enable error reporting for codepaths that do not explicitly return in a function. */,
    "noFallthroughCasesInSwitch": true /* Enable error reporting for fallthrough cases in switch statements. */,
    "noUncheckedIndexedAccess": true /* Add 'undefined' to a type when accessed using an index. */,
    "noImplicitOverride": false /* Ensure overriding members in derived classes are marked with an override modifier. */,
    "noPropertyAccessFromIndexSignature": false /* Enforces using indexed accessors for keys declared using an indexed type. */,
    "allowUnusedLabels": false /* Disable error reporting for unused labels. */,
    "allowUnreachableCode": false /* Disable error reporting for unreachable code. */,

    /* Completeness */
    "skipDefaultLibCheck": true /* Skip type checking .d.ts files that are included with TypeScript. */,
    "skipLibCheck": true /* Skip type checking all .d.ts files. */
  },
  "exclude": ["node_modules", "dist", "./prisma/generated/**/*.ts"]
}

@yangricardo
Copy link
Author

I fixed it, had to change some configurations in the turborepo that i was doing for my internal packages.
I am thinking that the build with tsup may produce the js and cjs modules with some loss of data of the packages or some tsx tool incompabillity

@erunion
Copy link
Member

erunion commented Mar 10, 2023

Very weird. [email protected] and [email protected] don't exist so I assume you were installing 20.4.0 and 20.5.3.

There are a lot of issues with Yarn because the installation process that happens when you generate an SDK executes npm directly. There's a known issue about that here #560

I haven't done any testing with turborepo, nor have I used that before, so I don't know what all would be different with that that we'd be breaking.

Sounds like you're good now though so we can close this out?

@yangricardo
Copy link
Author

yangricardo commented Mar 10, 2023

Seeing now, was a typo about the versions i mentioned, sorry.
Anyways, i think what you mentioned about the usage of yarn makes some sense. Also, as turborepo keeps something like a shared node_modules between the monorepo packages, i think the versions of new installation may have some incompatible with the old installation that i had in another package. I fixed it by generating a common package with the 3 dependencies needed and adopted the removal of tsup intermediary build of the generated code.
thanks for the attention

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:core Issues related to `core`, which is the package that powers the SDKs at runtime bug Something isn't working question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants