File Explorer

1/*2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.3 * SPDX-License-Identifier: Apache-2.0.4 */5 6import * as mqtt5 from "./mqtt5";7import * as test_utils from "@test/mqtt5";8import * as retry from "@test/retry";9import {v4 as uuid} from "uuid";10import url from "url";11import {HttpsProxyAgent} from "https-proxy-agent";12import * as auth from "./auth";13import {once} from "events";14import * as mqtt_server from "@test/mqtt_server";15import * as test_metrics from "@test/metrics";16import * as promise from "../common/promise";17import * as mqtt_shared from "../common/mqtt_shared";18import * as mqtt5_packet from "../common/mqtt5_packet";19 20jest.setTimeout(30000);21 22function createBrowserSpecificTestConfig (testType: test_utils.SuccessfulConnectionTestType) : mqtt5.Mqtt5ClientConfig {23 24    let wsOptions : any = {25        perMessageDeflate: false26    }27 28    if (test_utils.ClientEnvironmentalConfig.doesTestUseProxy(testType)) {29        let urlOptions: url.UrlWithStringQuery = url.parse(`http://${test_utils.ClientEnvironmentalConfig.PROXY_HOST}:${test_utils.ClientEnvironmentalConfig.PROXY_PORT}`);30        let agent = new HttpsProxyAgent(urlOptions.href!);31 32        wsOptions.agent = agent;33    }34 35    let urlFactoryOptions : mqtt5.Mqtt5WebsocketUrlFactoryOptions;36    if (test_utils.ClientEnvironmentalConfig.doesTestUseTls(testType)) {37        urlFactoryOptions = { urlFactory: mqtt5.Mqtt5WebsocketUrlFactoryType.Wss };38        wsOptions.rejectUnauthorized = false;39    } else {40        urlFactoryOptions = { urlFactory: mqtt5.Mqtt5WebsocketUrlFactoryType.Ws };41    }42 43    return {44        hostName: "unknown",45        port: 0,46 47        websocketOptions: {48            urlFactoryOptions: urlFactoryOptions,49            wsOptions: wsOptions50        }51    };52}53 54function makeMaximalConfig() : mqtt5.Mqtt5ClientConfig {55 56    let urlOptions: url.UrlWithStringQuery = url.parse(`http://${test_utils.ClientEnvironmentalConfig.PROXY_HOST}:${test_utils.ClientEnvironmentalConfig.PROXY_PORT}`);57    let agent = new HttpsProxyAgent(urlOptions.href!);58 59    return {60        hostName: test_utils.ClientEnvironmentalConfig.WS_MQTT_TLS_HOST,61        port: test_utils.ClientEnvironmentalConfig.WS_MQTT_TLS_PORT,62        sessionBehavior: mqtt5.ClientSessionBehavior.RejoinPostSuccess,63        retryJitterMode: mqtt5.RetryJitterType.Decorrelated,64        minReconnectDelayMs: 2000,65        maxReconnectDelayMs: 180000,66        minConnectedTimeToResetReconnectDelayMs: 60000,67        connectProperties: {68            keepAliveIntervalSeconds : 1800,69            clientId: `test${uuid()}`,70            username: 'notusingbasicauth',71            password: Buffer.from('notapassword', 'utf-8'),72            sessionExpiryIntervalSeconds: 3600,73            requestResponseInformation: true,74            requestProblemInformation: true,75            receiveMaximum: 100,76            maximumPacketSizeBytes: 256 * 1024,77            willDelayIntervalSeconds: 60,78            will: {79                topicName: `will/topic${uuid()}`,80                payload: Buffer.from("WillPayload", "utf-8"),81                qos: mqtt5.QoS.AtLeastOnce,82                retain: false,83                payloadFormat: mqtt5.PayloadFormatIndicator.Utf8,84                messageExpiryIntervalSeconds: 60,85                responseTopic: "talk/to/me",86                correlationData: Buffer.from("Sekrits", "utf-8"),87                contentType: "not-json",88                userProperties: [89                    {name:"will-name", value:"will-value"}90                ]91            },92            userProperties: [93                {name: "hello", value: "there"}94            ]95        },96        connectTimeoutMs: 30000,97        websocketOptions: {98            urlFactoryOptions: {99                urlFactory: mqtt5.Mqtt5WebsocketUrlFactoryType.Wss100            },101            wsOptions: {102                rejectUnauthorized: false,103                agent : agent104            }105        }106    };107}108 109test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasValidSuccessfulConnectionTestConfig(test_utils.SuccessfulConnectionTestType.WS_MQTT))('Connection Success - Websocket Mqtt', async () => {110    await retry.networkTimeoutRetryWrapper( async () => {111        await test_utils.testSuccessfulConnection(test_utils.SuccessfulConnectionTestType.WS_MQTT, createBrowserSpecificTestConfig);112    })113});114 115test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasValidSuccessfulConnectionTestConfig(test_utils.SuccessfulConnectionTestType.WS_MQTT_WITH_BASIC_AUTH))('Connection Success - Websocket Mqtt with basic authentication', async () => {116    await retry.networkTimeoutRetryWrapper( async () => {117        await test_utils.testSuccessfulConnection(test_utils.SuccessfulConnectionTestType.WS_MQTT_WITH_BASIC_AUTH, createBrowserSpecificTestConfig);118    })119});120 121 122test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasValidSuccessfulConnectionTestConfig(test_utils.SuccessfulConnectionTestType.WS_MQTT_WITH_TLS))('Connection Success - Websocket Mqtt with TLS', async () => {123    await retry.networkTimeoutRetryWrapper( async () => {124        await test_utils.testSuccessfulConnection(test_utils.SuccessfulConnectionTestType.WS_MQTT_WITH_TLS, createBrowserSpecificTestConfig);125    })126});127 128test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasValidSuccessfulConnectionTestConfig(test_utils.SuccessfulConnectionTestType.WS_MQTT_WITH_TLS_VIA_PROXY))('Connection Success - Websocket Mqtt with tls through an http proxy', async () => {129    await retry.networkTimeoutRetryWrapper( async () => {130        await test_utils.testSuccessfulConnection(test_utils.SuccessfulConnectionTestType.WS_MQTT_WITH_TLS_VIA_PROXY, createBrowserSpecificTestConfig);131    })132});133 134test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasValidSuccessfulConnectionTestConfig(test_utils.SuccessfulConnectionTestType.WS_MQTT_WITH_TLS_VIA_PROXY))('Connection Success - Websocket Mqtt with everything set', async () => {135    await retry.networkTimeoutRetryWrapper( async () => {136        let maximalConfig: mqtt5.Mqtt5ClientConfig = makeMaximalConfig();137 138        // @ts-ignore139        await test_utils.testConnect(new mqtt5.Mqtt5Client(maximalConfig));140    })141});142 143test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasValidSuccessfulConnectionTestConfig(test_utils.SuccessfulConnectionTestType.WS_MQTT))('Connection Failure - Websocket MQTT Bad host', async () => {144    // @ts-ignore145    await test_utils.testFailedConnection(new mqtt5.Mqtt5Client({146        hostName: 'localhst',147        port: test_utils.ClientEnvironmentalConfig.WS_MQTT_PORT148    }));149});150 151test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasValidSuccessfulConnectionTestConfig(test_utils.SuccessfulConnectionTestType.WS_MQTT))('Connection Failure - Websocket MQTT Bad port', async () => {152    // @ts-ignore153    await test_utils.testFailedConnection(new mqtt5.Mqtt5Client({154        hostName: test_utils.ClientEnvironmentalConfig.WS_MQTT_HOST,155        port: 9999156    }));157});158 159test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasValidSuccessfulConnectionTestConfig(test_utils.SuccessfulConnectionTestType.DIRECT_MQTT))('Connection Failure - Websocket MQTT protocol mismatch', async () => {160    // @ts-ignore161    await test_utils.testFailedConnection(new mqtt5.Mqtt5Client({162        hostName: test_utils.ClientEnvironmentalConfig.DIRECT_MQTT_HOST,163        port: test_utils.ClientEnvironmentalConfig.DIRECT_MQTT_PORT164    }));165});166 167test('Connection Failure - Websocket MQTT socket timeout', async () => {168    // @ts-ignore169    await test_utils.testFailedConnection(new mqtt5.Mqtt5Client({170        hostName: "example.com",171        port: 81,172        connectTimeoutMs: 3000,173    }));174});175 176test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasValidSuccessfulConnectionTestConfig(test_utils.SuccessfulConnectionTestType.WS_MQTT_WITH_TLS))('Connection Failure - Websocket MQTT Expected TLS', async () => {177    // @ts-ignore178    await test_utils.testFailedConnection(new mqtt5.Mqtt5Client({179        hostName: test_utils.ClientEnvironmentalConfig.WS_MQTT_TLS_HOST,180        port: test_utils.ClientEnvironmentalConfig.WS_MQTT_TLS_PORT181    }));182});183 184test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasValidSuccessfulConnectionTestConfig(test_utils.SuccessfulConnectionTestType.WS_MQTT))('Connection Failure - Websocket MQTT Expected Plain text', async () => {185    // @ts-ignore186    await test_utils.testFailedConnection(new mqtt5.Mqtt5Client({187        hostName: test_utils.ClientEnvironmentalConfig.WS_MQTT_HOST,188        port: test_utils.ClientEnvironmentalConfig.WS_MQTT_PORT,189        websocketOptions: {190            urlFactoryOptions: {191                urlFactory: mqtt5.Mqtt5WebsocketUrlFactoryType.Wss192            }193        }194    }));195});196 197test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasValidSuccessfulConnectionTestConfig(test_utils.SuccessfulConnectionTestType.WS_MQTT_WITH_BASIC_AUTH))('Connection Failure - Websocket Mqtt connection with basic authentication bad credentials', async () => {198    // @ts-ignore199    await test_utils.testFailedConnection(new mqtt5.Mqtt5Client({200        hostName: test_utils.ClientEnvironmentalConfig.WS_MQTT_BASIC_AUTH_HOST,201        port: test_utils.ClientEnvironmentalConfig.WS_MQTT_BASIC_AUTH_PORT,202        connectProperties : {203            keepAliveIntervalSeconds: 1200,204            username: "Wrong",205            password: Buffer.from("NotAPassword", "utf-8")206        }207    }));208});209 210function testFailedClientConstruction(config: mqtt5.Mqtt5ClientConfig) {211    expect(() => {212        new mqtt5.Mqtt5Client(config);213    }).toThrow();214}215 216function getBaseConstructionFailureConfig() : mqtt5.Mqtt5ClientConfig {217    return {218        hostName : "localhost",219        port : 1883,220        connectProperties: {221            keepAliveIntervalSeconds: 1200,222        }223    }224}225 226test('Client construction failure - bad config, keep alive underflow', async () => {227    let config : mqtt5.Mqtt5ClientConfig = getBaseConstructionFailureConfig();228    // @ts-ignore229    config.connectProperties.keepAliveIntervalSeconds = -1000;230    testFailedClientConstruction(config);231});232 233test('Client construction failure - bad config, keep alive overflow', async () => {234    let config : mqtt5.Mqtt5ClientConfig = getBaseConstructionFailureConfig();235    // @ts-ignore236    config.connectProperties.keepAliveIntervalSeconds = 65536;237    testFailedClientConstruction(config);238});239 240test('Client construction failure - bad config, session expiry underflow', async () => {241    let config : mqtt5.Mqtt5ClientConfig = getBaseConstructionFailureConfig();242    // @ts-ignore243    config.connectProperties.sessionExpiryIntervalSeconds = -1000;244    testFailedClientConstruction(config);245});246 247test('Client construction failure - bad config, session expiry overflow', async () => {248    let config : mqtt5.Mqtt5ClientConfig = getBaseConstructionFailureConfig();249    // @ts-ignore250    config.connectProperties.sessionExpiryIntervalSeconds = 4294967296;251    testFailedClientConstruction(config);252});253 254test('Client construction failure - bad config, receive maximum underflow', async () => {255    let config : mqtt5.Mqtt5ClientConfig = getBaseConstructionFailureConfig();256    // @ts-ignore257    config.connectProperties.receiveMaximum = -1000;258    testFailedClientConstruction(config);259});260 261test('Client construction failure - bad config, receive maximum overflow', async () => {262    let config : mqtt5.Mqtt5ClientConfig = getBaseConstructionFailureConfig();263    // @ts-ignore264    config.connectProperties.receiveMaximum = 65536;265    testFailedClientConstruction(config);266});267 268test('Client construction failure - bad config, maximum packet size underflow', async () => {269    let config : mqtt5.Mqtt5ClientConfig = getBaseConstructionFailureConfig();270    // @ts-ignore271    config.connectProperties.maximumPacketSizeBytes = 0;272    testFailedClientConstruction(config);273});274 275test('Client construction failure - bad config, maximum packet size overflow', async () => {276    let config : mqtt5.Mqtt5ClientConfig = getBaseConstructionFailureConfig();277    // @ts-ignore278    config.connectProperties.maximumPacketSizeBytes = 4294967296;279    testFailedClientConstruction(config);280});281 282test('Client construction failure - bad config, will delay interval underflow', async () => {283    let config : mqtt5.Mqtt5ClientConfig = getBaseConstructionFailureConfig();284    // @ts-ignore285    config.connectProperties.willDelayIntervalSeconds = -5;286    // @ts-ignore287    config.connectProperties.will = {288        topicName: "derp",289        qos: mqtt5.QoS.AtLeastOnce290    }291    testFailedClientConstruction(config);292});293 294test('Client construction failure - bad config, will delay interval overflow', async () => {295    let config : mqtt5.Mqtt5ClientConfig = getBaseConstructionFailureConfig();296    // @ts-ignore297    config.connectProperties.willDelayIntervalSeconds = 4294967296;298    // @ts-ignore299    config.connectProperties.will = {300        topicName: "derp",301        qos: mqtt5.QoS.AtLeastOnce302    }303    testFailedClientConstruction(config);304});305 306function createWsIotCoreClientConfig() : mqtt5.Mqtt5ClientConfig {307    let provider: auth.StaticCredentialProvider = new auth.StaticCredentialProvider({308        aws_access_id: test_utils.ClientEnvironmentalConfig.AWS_IOT_ACCESS_KEY_ID,309        aws_secret_key: test_utils.ClientEnvironmentalConfig.AWS_IOT_SECRET_ACCESS_KEY,310        aws_sts_token: test_utils.ClientEnvironmentalConfig.AWS_IOT_SESSION_TOKEN,311        aws_region: "us-east-1"312    });313 314    let websocketConfig: mqtt5.Mqtt5WebsocketConfig = {315        urlFactoryOptions: {316            urlFactory: mqtt5.Mqtt5WebsocketUrlFactoryType.Sigv4,317            region: "us-east-1",318            credentialsProvider: provider319        }320    };321 322    let config : mqtt5.Mqtt5ClientConfig = {323        hostName: test_utils.ClientEnvironmentalConfig.AWS_IOT_HOST,324        port: 443,325        connectProperties: {326            keepAliveIntervalSeconds: 1200327        },328        websocketOptions: websocketConfig329    }330 331    return config;332}333 334function createOperationFailureClient() : mqtt5.IMqtt5Client {335    return new mqtt5.Mqtt5Client(createWsIotCoreClientConfig());336}337 338test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Disconnection failure - session expiry underflow', async () => {339    await retry.networkTimeoutRetryWrapper( async () => {340        // @ts-ignore341        await test_utils.testDisconnectValidationFailure(createOperationFailureClient() as mqtt5.Mqtt5Client, -5);342    })343});344 345test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Disconnection failure - session expiry overflow', async () => {346    await retry.networkTimeoutRetryWrapper( async () => {347        // @ts-ignore348        await test_utils.testDisconnectValidationFailure(createOperationFailureClient() as mqtt5.Mqtt5Client, 4294967296);349    })350});351 352test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Publish failure - message expiry underflow', async () => {353    await retry.networkTimeoutRetryWrapper( async () => {354        // @ts-ignore355        await test_utils.testPublishValidationFailure(createOperationFailureClient(), -5);356    })357});358 359test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Publish failure - message expiry overflow', async () => {360    await retry.networkTimeoutRetryWrapper( async () => {361        // @ts-ignore362        await test_utils.testPublishValidationFailure(createOperationFailureClient(), 4294967297);363    })364});365 366test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Subscribe failure - subscription identifier underflow', async () => {367    await retry.networkTimeoutRetryWrapper( async () => {368        // @ts-ignore369        await test_utils.testSubscribeValidationFailure(createOperationFailureClient(), -5);370    })371});372 373test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Subscribe failure - subscription identifier overflow', async () => {374    await retry.networkTimeoutRetryWrapper( async () => {375        // @ts-ignore376        await test_utils.testSubscribeValidationFailure(createOperationFailureClient(), 4294967297);377    })378});379 380test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Negotiated settings - minimal', async () => {381    await retry.networkTimeoutRetryWrapper( async () => {382        let config: mqtt5.Mqtt5ClientConfig = createWsIotCoreClientConfig();383 384        if (config.connectProperties) {385            config.connectProperties.keepAliveIntervalSeconds = 600;386        }387 388        let client: mqtt5.Mqtt5Client = new mqtt5.Mqtt5Client(config);389 390        // @ts-ignore391        let settings: mqtt5_common.NegotiatedSettings = await test_utils.testNegotiatedSettings(client);392 393        expect(settings.serverKeepAlive).toEqual(600);394    })395});396 397test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Negotiated settings - maximal', async () => {398    await retry.networkTimeoutRetryWrapper( async () => {399        let clientId: string = "test-" + Math.floor(Math.random() * 100000000);400 401        let config: mqtt5.Mqtt5ClientConfig = createWsIotCoreClientConfig();402 403        if (config.connectProperties) {404            config.connectProperties.keepAliveIntervalSeconds = 600;405            config.connectProperties.sessionExpiryIntervalSeconds = 700406            config.connectProperties.clientId = clientId;407        }408 409        let client: mqtt5.Mqtt5Client = new mqtt5.Mqtt5Client(config);410 411        // @ts-ignore412        let settings: mqtt5_common.NegotiatedSettings = await test_utils.testNegotiatedSettings(client);413 414        expect(settings.serverKeepAlive).toEqual(600);415        // expect(settings.sessionExpiryInterval).toEqual(700); TODO: restore once IoT Core fixes session expiry416        expect(settings.clientId).toEqual(clientId);417    })418});419 420test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Negotiated settings - always rejoin session', async () => {421    await retry.networkTimeoutRetryWrapper( async () => {422        let clientId: string = `test-${uuid()}`;423        let config: mqtt5.Mqtt5ClientConfig = createWsIotCoreClientConfig();424        config.connectProperties = {425            clientId: clientId,426            keepAliveIntervalSeconds: 600,427            sessionExpiryIntervalSeconds: 3600,428        };429 430        let client: mqtt5.Mqtt5Client = new mqtt5.Mqtt5Client(config);431 432        // @ts-ignore433        await test_utils.testNegotiatedSettings(client, false);434 435        config.sessionBehavior = mqtt5.ClientSessionBehavior.RejoinAlways;436        let forcedRejoinClient: mqtt5.Mqtt5Client = new mqtt5.Mqtt5Client(config);437 438        // @ts-ignore439        await test_utils.testNegotiatedSettings(forcedRejoinClient, true);440    })441});442 443test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Sub - Pub QoS 0 - Unsub', async () => {444    await retry.networkTimeoutRetryWrapper( async () => {445        let topic: string = `test/${uuid()}`;446        let testPayload: Buffer = Buffer.from("Derp", "utf-8");447 448        let client: mqtt5.Mqtt5Client = new mqtt5.Mqtt5Client(createWsIotCoreClientConfig());449 450        let qos: mqtt5.QoS = mqtt5.QoS.AtMostOnce;451        let receivedCount: number = 0;452        client.on('messageReceived', (eventData: mqtt5.MessageReceivedEvent) => {453            let packet: mqtt5.PublishPacket = eventData.message;454 455            expect(packet.qos).toEqual(qos);456            expect(packet.payload).toEqual(testPayload);457            expect(packet.topicName).toEqual(topic);458            receivedCount++;459        });460 461        // @ts-ignore462        await test_utils.subPubUnsubTest(client, qos, topic, testPayload);463 464        expect(receivedCount).toEqual(1);465    })466});467 468test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Sub - Pub QoS 1 - Unsub', async () => {469    await retry.networkTimeoutRetryWrapper( async () => {470        let topic: string = `test/${uuid()}`;471        let testPayload: Buffer = Buffer.from("Derp", "utf-8");472 473        let client: mqtt5.Mqtt5Client = new mqtt5.Mqtt5Client(createWsIotCoreClientConfig());474 475        let qos: mqtt5.QoS = mqtt5.QoS.AtLeastOnce;476        let receivedCount: number = 0;477        client.on('messageReceived', (eventData: mqtt5.MessageReceivedEvent) => {478            let packet: mqtt5.PublishPacket = eventData.message;479 480            expect(packet.qos).toEqual(qos);481            expect(packet.payload).toEqual(testPayload);482            expect(packet.topicName).toEqual(topic);483            receivedCount++;484        });485 486        // @ts-ignore487        await test_utils.subPubUnsubTest(client, qos, topic, testPayload);488 489        expect(receivedCount).toEqual(1);490    })491});492 493test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Will test', async () => {494    await retry.networkTimeoutRetryWrapper( async () => {495        let willPayload: Buffer = Buffer.from("ToMyChildrenIBequeathNothing", "utf-8");496        let willTopic: string = `test/will/test${uuid()}`;497 498        let publisherConfig: mqtt5.Mqtt5ClientConfig = createWsIotCoreClientConfig();499 500        if (publisherConfig.connectProperties) {501            publisherConfig.connectProperties.willDelayIntervalSeconds = 0;502            publisherConfig.connectProperties.will = {503                topicName: willTopic,504                qos: mqtt5.QoS.AtLeastOnce,505                payload: willPayload506            };507        }508 509        let publisher: mqtt5.Mqtt5Client = new mqtt5.Mqtt5Client(publisherConfig);510 511        let subscriber: mqtt5.Mqtt5Client = new mqtt5.Mqtt5Client(createWsIotCoreClientConfig());512 513        let willReceived: boolean = false;514        subscriber.on('messageReceived', (eventData: mqtt5.MessageReceivedEvent) => {515            let packet: mqtt5.PublishPacket = eventData.message;516 517            expect(packet.qos).toEqual(mqtt5.QoS.AtLeastOnce);518            expect(Buffer.from(packet.payload as ArrayBuffer)).toEqual(willPayload);519            expect(packet.topicName).toEqual(willTopic);520            willReceived = true;521        });522 523        // @ts-ignore524        await test_utils.willTest(publisher, subscriber, willTopic);525 526        expect(willReceived).toEqual(true);527    })528});529 530function createNullOperationClient() : mqtt5.Mqtt5Client {531    return new mqtt5.Mqtt5Client(createWsIotCoreClientConfig())532}533 534test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Operation failure - null subscribe', async () => {535    await retry.networkTimeoutRetryWrapper( async () => {536        // @ts-ignore537        await test_utils.nullSubscribeTest(createNullOperationClient());538    })539});540 541test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Operation failure - null unsubscribe', async () => {542    await retry.networkTimeoutRetryWrapper( async () => {543        // @ts-ignore544        await test_utils.nullUnsubscribeTest(createNullOperationClient());545    })546});547 548test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Operation failure - null publish', async () => {549    await retry.networkTimeoutRetryWrapper( async () => {550        // @ts-ignore551        await test_utils.nullPublishTest(createNullOperationClient());552    })553});554 555test_utils.conditional_test(test_utils.ClientEnvironmentalConfig.hasIotCoreEnvironment())('Retain test', async () => {556    await retry.networkTimeoutRetryWrapper( async () => {557        let config: mqtt5.Mqtt5ClientConfig = createWsIotCoreClientConfig();558 559        // @ts-ignore560        await test_utils.doRetainTest(new mqtt5.Mqtt5Client(config), new mqtt5.Mqtt5Client(config), new mqtt5.Mqtt5Client(config));561    })562});563 564class ClientTestFixture {565 566    private server : mqtt_server.MqttServer;567 568    constructor(config: mqtt_server.MqttServerConfig) {569        this.server = new mqtt_server.MqttServer(config);570    }571 572    async start() {573        await this.server.start();574    }575 576    getServer() : mqtt_server.MqttServer { return this.server; }577}578 579function buildDefaultClientConfig(fixture : ClientTestFixture) : mqtt5.Mqtt5ClientConfig {580    return {581        hostName: "localhost",582        port: fixture.getServer().getPort(),583        sessionBehavior: mqtt5.ClientSessionBehavior.Default,584        connectProperties: {585            keepAliveIntervalSeconds: 120586        },587        connectTimeoutMs: 10000,588        websocketOptions: {589            urlFactoryOptions: {590                urlFactory: mqtt5.Mqtt5WebsocketUrlFactoryType.Ws591            }592        }593    };594}595 596test('Manual Puback - Acquire', async () => {597    let config: mqtt_server.MqttServerConfig = {598        protocolVersion: mqtt_shared.ProtocolMode.Mqtt5599    };600 601    let fixture = new ClientTestFixture(config);602    await fixture.start();603 604    let clientConfig = buildDefaultClientConfig(fixture);605    let client = new mqtt5.Mqtt5Client(clientConfig);606 607    let connectionSuccess = once(client, "connectionSuccess");608    let stopped = once(client, "stopped");609 610    client.start();611    await connectionSuccess;612 613    let pubackReceived : boolean = false;614    let ackHandlePromise : promise.LiftedPromise<mqtt_shared.PublishAcknowledgementHandle> = promise.newLiftedPromise<mqtt_shared.PublishAcknowledgementHandle>();615 616    client.addListener(mqtt5.Mqtt5Client.MESSAGE_RECEIVED, (event : mqtt5.MessageReceivedEvent) => {617        if (event.message.qos != mqtt5_packet.QoS.AtMostOnce) {618            expect(event.acknowledgementControl).toBeDefined();619 620            // @ts-ignore621            ackHandlePromise.resolve(event.acknowledgementControl.acquireHandle());622        }623    });624 625    let serverPuback= promise.newLiftedPromise<mqtt5_packet.PubackPacket>();626    fixture.getServer().addListener('packetReceived', (packet : mqtt5_packet.IPacket) => {627        if (packet.type == mqtt5_packet.PacketType.Puback) {628            pubackReceived = true;629            serverPuback.resolve(packet as mqtt5_packet.PubackPacket);630        }631    });632 633    await client.publish({634        topicName: "test/topic",635        qos: mqtt5_packet.QoS.AtLeastOnce636    });637 638    let ackHandle : mqtt_shared.PublishAcknowledgementHandle = await ackHandlePromise.promise;639 640    // Awkward way of trying to check that a puback didn't get automatically sent.  We wait for a generous period of641    // time and verify that the flag is still false (we can't check the promise for non-resolution).642    await new Promise((resolve, reject) => setTimeout(resolve, 1000));643 644    expect(pubackReceived).toBe(false);645 646    ackHandle.invokeAcknowledgement();647 648    await serverPuback.promise;649    expect(pubackReceived).toBe(true);650 651    client.stop();652    await stopped;653 654    fixture.getServer().stop();655});656 657test('Manual Puback - No Acquire', async () => {658    let config: mqtt_server.MqttServerConfig = {659        protocolVersion: mqtt_shared.ProtocolMode.Mqtt5660    };661 662    let fixture = new ClientTestFixture(config);663    await fixture.start();664 665    let clientConfig = buildDefaultClientConfig(fixture);666    let client = new mqtt5.Mqtt5Client(clientConfig);667 668    let connectionSuccess = once(client, "connectionSuccess");669    let stopped = once(client, "stopped");670 671    client.start();672    await connectionSuccess;673 674    let pubackReceived : boolean = false;675    let serverPuback= promise.newLiftedPromise<mqtt5_packet.PubackPacket>();676    fixture.getServer().addListener('packetReceived', (packet : mqtt5_packet.IPacket) => {677        if (packet.type == mqtt5_packet.PacketType.Puback) {678            pubackReceived = true;679            serverPuback.resolve(packet as mqtt5_packet.PubackPacket);680        }681    });682 683    await client.publish({684        topicName: "test/topic",685        qos: mqtt5_packet.QoS.AtLeastOnce686    });687 688    await serverPuback.promise;689    expect(pubackReceived).toBe(true);690 691    client.stop();692    await stopped;693 694    fixture.getServer().stop();695});696 697async function doMetricsTestConnect5(server: mqtt_server.MqttServer, disableMetrics: boolean, username?: string) {698    let clientConfig : mqtt5.Mqtt5ClientConfig = {699        hostName: "localhost",700        port: server.getPort(),701        disableMetrics: disableMetrics,702        websocketOptions: {703            urlFactoryOptions: {704                urlFactory: mqtt5.Mqtt5WebsocketUrlFactoryType.Ws705            }706        }707    };708 709    if (username !== undefined) {710        clientConfig.connectProperties = {711            keepAliveIntervalSeconds: 1200,712            username: username713        };714    }715 716    let client = new mqtt5.Mqtt5Client(clientConfig);717 718    let connectionSuccess = once(client, 'connectionSuccess');719    client.start();720 721    await connectionSuccess;722}723 724test('mqtt5 metrics - enabled, undefined username', async () => {725    await test_metrics.doMetricsUsernameTest(mqtt_shared.ProtocolMode.Mqtt5, doMetricsTestConnect5, false);726});727 728test('mqtt5 metrics - disabled, undefined username', async () => {729    await test_metrics.doMetricsUsernameTest(mqtt_shared.ProtocolMode.Mqtt5, doMetricsTestConnect5, true);730});731 732test('mqtt5 metrics - enabled, non-empty username', async () => {733    await test_metrics.doMetricsUsernameTest(mqtt_shared.ProtocolMode.Mqtt5, doMetricsTestConnect5, false, "hello");734});735 736test('mqtt5 metrics - disabled, non-empty username', async () => {737    await test_metrics.doMetricsUsernameTest(mqtt_shared.ProtocolMode.Mqtt5, doMetricsTestConnect5, true, "world");738});