Uploaded image for project: 'Couchbase node.js Client Library'
  1. Couchbase node.js Client Library
  2. JSCBC-978

Migration and Release Notes Items

    XMLWordPrintable

Details

    • Task
    • Status: Resolved
    • Critical
    • Resolution: Fixed
    • 4.0.0
    • None
    • docs
    • None
    • 1

    Description

      To complete the 4.0 release, docs will need to be updated in both the migration guide and the release notes. While not much is expected to change, we do need a list of those items. Filing this to verify we complete it before 4.0.

      Needed:

      • Deprecated items which have been removed
      • Features which may have changed or are missing
      • Any other considerations in migrating

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            • How do Client Settings work now? Can we still direct people to the libcouchbase docs?
            hakim.cassimally Hakim Cassimally added a comment - How do Client Settings work now? Can we still direct people to the libcouchbase docs?

            Hey Hakim,

            • Log Forwarding is in fact the log hooking that makes them available via an interface in Node.js.
            • The view query reduce option used to take a string in error, and now takes a boolean.
            • Error messages never really were visible to users as LCB_, they were things like DocumentNotFoundError.
            • Log Levels are very different from LCB to couchbase++, I don't know if we have a full list yet (or will in time for release).
            • Logging is quite different, I'm not sure we are ready to discuss 'best practices' on it at this point.

            Cheers, Brett

            brett19 Brett Lawson added a comment - Hey Hakim, Log Forwarding is in fact the log hooking that makes them available via an interface in Node.js. The view query reduce option used to take a string in error, and now takes a boolean. Error messages never really were visible to users as LCB_, they were things like DocumentNotFoundError. Log Levels are very different from LCB to couchbase++, I don't know if we have a full list yet (or will in time for release). Logging is quite different, I'm not sure we are ready to discuss 'best practices' on it at this point. Cheers, Brett

            Thanks Brett, I'll make some tweaks for review later.

            I'll keep https://osfameron.github.io/DOC-9626-NodeJS-4-migration/nodejs-sdk/current/hello-world/start-using-sdk.html

            updated today. /CC Arun Vijayraghavan 

            hakim.cassimally Hakim Cassimally added a comment - Thanks Brett, I'll make some tweaks for review later. I'll keep https://osfameron.github.io/DOC-9626-NodeJS-4-migration/nodejs-sdk/current/hello-world/start-using-sdk.html updated today. /CC Arun Vijayraghavan  
            brett19 Brett Lawson added a comment - - edited

            Hey Richard Smedley, I've just managed to publish 4.0.0 to NPM. I'm not sure what the intent is for the release notes for the 4.x series, as I saw that there is reference to a joint release notes section between 3.x and 4.x, here are the release notes for 4.0.0:

            == Version 4.0.0 (18 February 2022)
             
            Version 4.0.0 is the first major release of the next generation Node.js SDK, bringing a number of improvements related to internal connection behaviour.
             
            [source,console]
            ----
            $ npm install couchbase@4.0.0
            ----
             
            http://docs.couchbase.com/sdk-api/couchbase-node-client-4.0.0/[API Reference]
             
            === New Features
            * Cluster options are now sectioned into individual options blocks.
            * Support for distributed transactions has now been implemented.
            * Reimplemented the library using couchbase++.
             
            === Fixed Issues
            * http://issues.couchbase.com/browse/JSCBC-878[JSCBC-878]:
            Diagnostics functions now returned fully typed results.
            * http://issues.couchbase.com/browse/JSCBC-1007[JSCBC-1007]:
            first_error_message/first_error_code are no longer available on error contexts.
            * Search scan consistency included RequestPlus in error and it has now been removed.
            * Performing a GET operation against a locked document now retries internally.
            * The view query reduce option used to take a string in error, and now takes a boolean.
            * Following with Node.js EOL, v12 is now the minimum version.
             
             
            === Known Issues
            * http://issues.couchbase.com/browse/JSCBC-1011[JSCBC-1011]:
            Core IO logging is not forwarded through to Node.js.
            * http://issues.couchbase.com/browse/JSCBC-1040[JSCBC-1040]:
            Distributed tracing is not yet supported.
            * http://issues.couchbase.com/browse/JSCBC-1041[JSCBC-1041]:
            Replica reads are not yet supported.
            * http://issues.couchbase.com/browse/JSCBC-1042[JSCBC-1042]:
            Legacy durability operations are not yet supported.
            

            brett19 Brett Lawson added a comment - - edited Hey Richard Smedley , I've just managed to publish 4.0.0 to NPM. I'm not sure what the intent is for the release notes for the 4.x series, as I saw that there is reference to a joint release notes section between 3.x and 4.x, here are the release notes for 4.0.0: == Version 4.0.0 (18 February 2022)   Version 4.0.0 is the first major release of the next generation Node.js SDK, bringing a number of improvements related to internal connection behaviour.   [source,console] ---- $ npm install couchbase@4.0.0 ----   http://docs.couchbase.com/sdk-api/couchbase-node-client-4.0.0/[API Reference]   === New Features * Cluster options are now sectioned into individual options blocks. * Support for distributed transactions has now been implemented. * Reimplemented the library using couchbase++.   === Fixed Issues * http://issues.couchbase.com/browse/JSCBC-878[JSCBC-878]: Diagnostics functions now returned fully typed results. * http://issues.couchbase.com/browse/JSCBC-1007[JSCBC-1007]: first_error_message/first_error_code are no longer available on error contexts. * Search scan consistency included RequestPlus in error and it has now been removed. * Performing a GET operation against a locked document now retries internally. * The view query reduce option used to take a string in error, and now takes a boolean. * Following with Node.js EOL, v12 is now the minimum version.     === Known Issues * http://issues.couchbase.com/browse/JSCBC-1011[JSCBC-1011]: Core IO logging is not forwarded through to Node.js. * http://issues.couchbase.com/browse/JSCBC-1040[JSCBC-1040]: Distributed tracing is not yet supported. * http://issues.couchbase.com/browse/JSCBC-1041[JSCBC-1041]: Replica reads are not yet supported. * http://issues.couchbase.com/browse/JSCBC-1042[JSCBC-1042]: Legacy durability operations are not yet supported.
            richard.smedley Richard Smedley added a comment - Thanks Brett Lawson   https://docs.couchbase.com/nodejs-sdk/current/project-docs/sdk-release-notes.html#version-4-0-0-18-february-2022 is up on the docs site, along with https://docs.couchbase.com/nodejs-sdk/current/project-docs/migrating-sdk-code-to-3.n.html and https://docs.couchbase.com/nodejs-sdk/current/howtos/distributed-acid-transactions-from-the-sdk.html ples updated compat guide and getting started.

            People

              hakim.cassimally Hakim Cassimally
              ingenthr Matt Ingenthron
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty